home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1995 April / Internet Tools.iso / infoserv / gopher / Unix / moog-0.2.README < prev    next >
Encoding:
Text File  |  1993-12-28  |  4.4 KB  |  132 lines
  1. <URL:ftp://genie.lut.ac.uk/moog-0.2.README>
  2.  
  3. 16th December 1993
  4.  
  5. Hi!  This is the README from moog version 0.2.  moog is an X Window
  6. gopher client for Unix boxes, written using Tk & Perl.  This is an
  7. alpha-type release which I'm putting out for feedback as I won't have
  8. time to do much more before Xmas.  If you use it, let me know of any
  9. problems you experience, and of any improvements you'd like to see.
  10.  
  11. My Internet E-Mail address is <M.T.Hamilton@lut.ac.uk>
  12.  
  13. NB:  Don't use this software if you want something stable and well
  14. supported, as it's a one man band job (me!)
  15.  
  16. Martin.
  17.  
  18.  
  19.  
  20. REQUIREMENTS:
  21.  
  22. To run this version of moog, you must have a fairly recent version of
  23. Tcl/Tk and Perl installed on your machine - I've run it with Perl
  24. 4.036 and the following O/S and Tk combinations:
  25.  
  26.   SunOS 4.1.[123]    Tk 3.6
  27.   Solaris 2.3        Tk 3.6 (SunOS 4.1 binary compatability package)
  28.   HP-UX 9.00         Tk 3.2
  29.   IRIX 4.0.5         Tk 3.6
  30.   Ultrix 4.3         Tk 3.6
  31.  
  32.  
  33. INSTALLATION:
  34.  
  35. First, obtain moog-0.2.tar.Z, now explode this wherever you want to
  36. install the package, e.g.
  37.  
  38.   # cd /usr/local/lib
  39.   # zcat /tmp/moog-0.2.tar.Z | tar xvf -
  40.  
  41. unpacks moog inside /usr/local/lib/moog-0.2.
  42.  
  43. Firstly you will need to edit "moog" and "plunder" to reflect the
  44. locations of wish and perl on your machine.  Straight out of the box,
  45. the distribution expects to find these in /usr/local/bin.
  46.  
  47. Now you may need to customise some files.
  48.  
  49. First: "moog".  There is a bank of variables at the top of this file
  50. which tell moog its overall configuration.  This is what they mean:
  51.  
  52.   auto_path        - should include the directory you unpacked moog in
  53.   markFile         - name of file to use to store moog bookmarks
  54.   fallbackMarkFile - full path name of gopher helper application defaults
  55.                        file, see below - "dot.gopherrc" is an example
  56.   moogRC           - full path name of system wide configuration file,
  57.                        see below - "dot.moog" is an example
  58.   rootServer       - name of root gopher server
  59.   rootPort         - port number root gopher server is listening on
  60.   where            - directory to put temporary files in
  61.  
  62. moog uses the same file structure for its bookmarks as the curses gopher
  63. client, so you can share bookmarks between the two if you like.  The
  64. "fallbackMarkFile" is a template to use when creating a bookmarks file
  65. for the first time.  You may want to change this to match the helper
  66. applications used by the curses client on your machine.
  67.  
  68. "moogRC" tells moog what applications to launch when you fetch an item
  69. of a particular type.  If there is a .moog file in your home directory
  70. this will be used in preference to the system wide one specified by
  71. the "moogRC" variable.  This file has an entry for each of the objects
  72. you want moog to be able to process, of the form...
  73.  
  74.   8:Tel:d:e:Telnet session:xterm -title "%T - login as %P" -e telnet %h %p
  75.   
  76. What this says is "for objects of type _8_ (i.e. telnet), _d_on't bother
  77. to fetch them from the gopher server, and run the _e_xternal helper
  78. application xterm (with some other parameters - see below) when they
  79. are selected."  It also says to mark directory entries of this type with
  80. the letters "Tel" in gopher directory listings, and gives the object the
  81. human readable title "Telnet session" (not presently used).
  82.  
  83. OK values for the third field (object download options) are
  84.  
  85.   a: download as ASCII (strip out linefeed characters and trailing ".")
  86.   b: download in binary
  87.   d: don't download!
  88.  
  89. OK values for the fourth field (linkage) are
  90.  
  91.   i: evaluate the piece of Tcl/Tk code specified in the last field
  92.   e: execute the external program specified in the last field
  93.   u: don't know what to do!
  94.  
  95. Finally, the following characters are interpolated when they appear in
  96. the "command" field:
  97.  
  98.   %t - the object's type
  99.   %h - host name of the remote server
  100.   %p - it's port number
  101.   %T - the object's title
  102.   %P - the path to the object, once connected to the remote server
  103.   %f - the name of the temporary file the object has been downloaded to
  104.         (doesn't apply when the download option is "d")
  105.  
  106.  
  107. RUNNING:
  108.  
  109. Place the directory where moog is installed in your path, e.g. (csh)
  110.  
  111.   % set path = ($path /usr/local/lib/moog-0.2)
  112.   % rehash
  113.  
  114. or (sh/bash/...)
  115.  
  116.   $ PATH=$PATH:/usr/local/lib/moog-0.2
  117.   $ export PATH
  118.  
  119. Now you can run it like this
  120.  
  121.   % moog
  122.  
  123. You can also give moog a host name, or host name and port number (the
  124. default is 70) on the command line, e.g.
  125.  
  126.   % moog genie
  127.  
  128. or
  129.  
  130.   % moog genie 4320
  131.  
  132.